Inside Macintosh: Telephony /

Chapter 1 - Introduction to Telephony on the Macintosh / Telephone Manager Initialization Reference

Telephone Manager Initialization Functions / Configuring a Telephone Tool Through a Custom Interface

TELSetupFilter

Implements the filtering procedure provided by a telephone tool for handling tool-specific events for your custom tool-settings dialog box.

pascal Boolean TELSetupFilter (
                     short procID,
                     Ptr theConfig,
                     short count,
                     DialogPtr theDialog,
                     EventRecord *theEvent,
                     short *theItem
                     long *magicCookie);

procID

The tool ID for the telephone tool being configured.

theConfig

A pointer to the configuration field in the telephone record for the telephone tool being configured.

count

The number of the first item in the dialog item list that you appended to your custom tool-settings dialog box.

theDialog

A pointer to the dialog box in which configuration is taking place.

theEvent

The event for which the filtering is to take place.

theItem

The item selected by the user in the custom tool-settings dialog box.

magicCookie

A pointer to a reserved area of memory used by the telephone tool to pass relevant dialog items and configuration settings.

function result

A Boolean value that indicates whether tool-specific events are filtered. This allows the telephone tool to perform the filtering for events that it knows about. A value of true is returned when an event is handled by the telephone tool. If the event is not handled by the telephone tool, a value of false is returned and you are responsible for handling the event.

DESCRIPTION

You should call the TELSetupFilter function before calling any standard modal dialog box filter procedures that are specific for your interface. The tool ID is assigned for a telephone tool through the TELGetProcID function. The dialog item list is stored in a reserved area of memory specified by the magicCookie pointer assigned through the TELSetupPreflight function. You can determine the number of items in the dialog item list by using the CountDITL function described in Inside Macintosh: Macintosh Toolbox Essentials.